// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_BASE_IME_CHROMEOS_IME_CNADIDATE_WINDOW_HANDLER_INTERFACE_H_
#define UI_BASE_IME_CHROMEOS_IME_CNADIDATE_WINDOW_HANDLER_INTERFACE_H_

#include <stdint.h>

#include "base/strings/string16.h"
#include "ui/base/ime/ui_base_ime_export.h"

namespace gfx {
class Rect;
} // namespace gfx

namespace ui {
class CandidateWindow;
}

namespace chromeos {

// A interface to handle the candidate window related method call.
class UI_BASE_IME_EXPORT IMECandidateWindowHandlerInterface {
public:
    virtual ~IMECandidateWindowHandlerInterface() { }

    // Called when the IME updates the lookup table.
    virtual void UpdateLookupTable(const ui::CandidateWindow& candidate_window,
        bool visible)
        = 0;

    // Called when the IME updates the preedit text. The |text| is given in
    // UTF-16 encoding.
    virtual void UpdatePreeditText(const base::string16& text,
        uint32_t cursor_pos,
        bool visible)
        = 0;

    // Called when the application changes its caret bounds.
    virtual void SetCursorBounds(const gfx::Rect& cursor_bounds,
        const gfx::Rect& composition_head)
        = 0;

    // Called when the text field's focus state is changed.
    // |is_focused| is true when the text field gains the focus.
    virtual void FocusStateChanged(bool is_focused) { }

protected:
    IMECandidateWindowHandlerInterface() { }
};

} // namespace chromeos

#endif // UI_BASE_IME_CHROMEOS_IME_CNADIDATE_WINDOW_HANDLER_INTERFACE_H_
